Resource StructureDefinition/FHIR Server from package nictiz.fhir.nl.r4.nl-core#0.11.0-beta.1 (94 ms)
| Package | nictiz.fhir.nl.r4.nl-core |
| Type | StructureDefinition |
| Id | Id |
| FHIR Version | R4 |
| Source | https://simplifier.net/resolve?scope=nictiz.fhir.nl.r4.nl-core@0.11.0-beta.1&canonical=http://nictiz.nl/fhir/StructureDefinition/nl-core-NameInformation |
| Url | http://nictiz.nl/fhir/StructureDefinition/nl-core-NameInformation |
| Status | draft |
| Name | NlcoreNameInformation |
| Title | nl core NameInformation |
| Experimental | False |
| Realm | nl |
| Description | A person's official name information, including given names, last name and possibly the partner's last name. |
| Purpose | A derived profile from [zib-NameInformation](http://nictiz.nl/fhir/StructureDefinition/zib-NameInformation) to provide a version better suited for implementation purposes. This profile augments the base profile with elements found in the various use cases that have adopted the zib.
For the entire zib, the complementary profile [nl-core-NameInformation.GivenName](http://nictiz.nl/fhir/StructureDefinition/nl-core-NameInformation.GivenName) should be used. Both profiles can be added in a slice with the discriminator set to `value`/`use`. |
| Copyright | Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise. |
| Type | HumanName |
| Kind | complex-type |
Resources that use this resource
Resources that this resource uses
Narrative
Note: links and images are rebased to the (stated) source
No narrative is provided for definitional resources. A human-readable rendering can be found in the implementation guide(s) where this resource is used.
Source
{
"resourceType" : "StructureDefinition",
"id" : "nl-core-NameInformation",
"text" : {
"status" : "empty",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">No narrative is provided for definitional resources. A human-readable rendering can be found in the implementation guide(s) where this resource is used.</div>"
},
"url" : "http://nictiz.nl/fhir/StructureDefinition/nl-core-NameInformation",
"name" : "NlcoreNameInformation",
"title" : "nl core NameInformation",
"status" : "draft",
"publisher" : "Nictiz",
"contact" : [
{
"name" : "Nictiz",
"telecom" : [
{
"system" : "url",
"value" : "https://www.nictiz.nl",
"use" : "work"
}
]
}
],
"description" : "A person's official name information, including given names, last name and possibly the partner's last name.",
"purpose" : "A derived profile from [zib-NameInformation](http://nictiz.nl/fhir/StructureDefinition/zib-NameInformation) to provide a version better suited for implementation purposes. This profile augments the base profile with elements found in the various use cases that have adopted the zib.\r\n\r\nFor the entire zib, the complementary profile [nl-core-NameInformation.GivenName](http://nictiz.nl/fhir/StructureDefinition/nl-core-NameInformation.GivenName) should be used. Both profiles can be added in a slice with the discriminator set to `value`/`use`.",
"copyright" : "Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.",
"fhirVersion" : "4.0.1",
"mapping" : [
{
"identity" : "zib-nameinformation-v1.1-2020EN",
"uri" : "https://zibs.nl/wiki/NameInformation-v1.1(2020EN)",
"name" : "zib NameInformation-v1.1(2020EN)"
}
],
"kind" : "complex-type",
"abstract" : false,
"type" : "HumanName",
"baseDefinition" : "http://nictiz.nl/fhir/StructureDefinition/zib-NameInformation",
"derivation" : "constraint",
"differential" : {
"element" : [
{
"id" : "HumanName",
"path" : "HumanName",
"comment" : "This `.name` element accomodates the official parts of a Dutch name according to common international usage and optionally to the [zib NameInformation v1.1 (2020)](https://zibs.nl/wiki/NameInformation-v1.1(2020EN)). An official Dutch name is represented in FHIR as an ordinary international name, optionally augmented using extensions to specify how the last name is built up according to the Dutch rules if conformance to the zib is required. See the guidance on `.family` and on `.extension:nameUsage` for more information.\r\n\r\nSystems that need to work in a Dutch context SHOULD support the extensions as specified in `.given`, `.family` and `.extension:nameUsage`. In addition, systems SHOULD use the core elements according to the FHIR specifications to provide compatibility outside Dutch contexts. This means that:\r\n* If parts of the name are specified using one or more of the structured elements, the `.text` element SHOULD be populated with a rendered version of the full name.\r\n* If parts of the family name are specified using the extensions in `.family`, the `.family` element SHOULD be populated with the full family name.\r\n\r\n**Note 1**: The zib cannot be represented straightforward in FHIR. Especially note the guidance on `.given` on how to map the FirstNames and Initials concepts, and on `.prefix`/`.suffix` on how to map the Titles concept.\r\n\r\n**Note 2**: This element should only contain a person's _official_ names. The GivenName concept is represented in another `.name` element with `.name.use` = _usual_.\r\n\r\n**Note 3**: The examples illustrate how the zib is mapped to FHIR.",
"alias" : [
"nl-core-NameInformation"
],
"constraint" : [
{
"key" : "nl-core-NameInformation-01",
"severity" : "warning",
"human" : "If parts of the name are specified using one or more of the structured elements, the `.text` element SHOULD be populated with a rendered version of the full name. This ensures compatibility with common FHIR usage.",
"expression" : "(family.exists() or given.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value != 'IN').exists()) implies text.hasValue()"
}
]
},
{
"id" : "HumanName.text",
"path" : "HumanName.text",
"comment" : "A representation of the full name, including given names and the family name.\r\n\r\nWhen implementing zib NameInformation, this representation should include the FirstNames or Initials and the family name constructed according to the NameUsage concept.",
"condition" : [
"nl-core-NameInformation-01"
],
"mapping" : [
{
"identity" : "zib-nameinformation-v1.1-2020EN",
"map" : "NL-CM:20.4.4",
"comment" : "FirstNames (implicit, main mapping is on .given)"
},
{
"identity" : "zib-nameinformation-v1.1-2020EN",
"map" : "NL-CM:20.4.5",
"comment" : "Initials (implicit, main mapping is on .given)"
},
{
"identity" : "zib-nameinformation-v1.1-2020EN",
"map" : "NL-CM:20.4.7",
"comment" : "NameUsage (implicit, main mapping is on extension:nameUsage)"
},
{
"identity" : "zib-nameinformation-v1.1-2020EN",
"map" : "NL-CM:20.4.11",
"comment" : "Prefix (implicit, main mapping is on .family.extension:prefix)"
},
{
"identity" : "zib-nameinformation-v1.1-2020EN",
"map" : "NL-CM:20.4.10",
"comment" : "LastName (implicit, main mapping is on .family.extension:lastName)"
},
{
"identity" : "zib-nameinformation-v1.1-2020EN",
"map" : "NL-CM:20.4.9",
"comment" : "PartnerPrefix (implicit, main mapping is on .family.extension:partnerPrefix)"
},
{
"identity" : "zib-nameinformation-v1.1-2020EN",
"map" : "NL-CM:20.4.8",
"comment" : "PartnerLastName (implicit, main mapping is on .family.extension:partnerLastName)"
}
]
},
{
"id" : "HumanName.family",
"path" : "HumanName.family",
"comment" : "When implementing zib NameInformation, this representation should be constrcuted from the Prefix, LastName, PartnerPrefix and/or PartnerLastName concepts according to the NameUsage concept.",
"condition" : [
"nl-core-NameInformation-01"
],
"constraint" : [
{
"key" : "nl-core-NameInformation-02",
"severity" : "warning",
"human" : "If parts of the family name are specified using the extensions in .family, the .family element SHOULD be populated with the full family name as well. This ensures compatibility with common FHIR usage.",
"expression" : "(extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').exists()) implies $this.hasValue()"
}
],
"mapping" : [
{
"identity" : "zib-nameinformation-v1.1-2020EN",
"map" : "NL-CM:20.4.7",
"comment" : "NameUsage (implicit, main mapping is on extension:nameUsage)"
},
{
"identity" : "zib-nameinformation-v1.1-2020EN",
"map" : "NL-CM:20.4.11",
"comment" : "Prefix (implicit, main mapping is on .family.extension:prefix)"
},
{
"identity" : "zib-nameinformation-v1.1-2020EN",
"map" : "NL-CM:20.4.10",
"comment" : "LastName (implicit, main mapping is on .family.extension:lastName)"
},
{
"identity" : "zib-nameinformation-v1.1-2020EN",
"map" : "NL-CM:20.4.9",
"comment" : "PartnerPrefix (implicit, main mapping is on .family.extension:partnerPrefix)"
},
{
"identity" : "zib-nameinformation-v1.1-2020EN",
"map" : "NL-CM:20.4.8",
"comment" : "PartnerLastName (implicit, main mapping is on .family.extension:partnerLastName)"
}
]
},
{
"id" : "HumanName.given",
"path" : "HumanName.given",
"comment" : "This element can be used to represent full given names or initials. `extension:givenOrInitial` SHALL be used on each repretition to specifiy if it's a full name (_BR_) or an initial (_IN_).\r\n\r\n## Zib compatibility\r\n\r\nTthis element is used to represent the FirstNames and Initials concepts of zib NameInformation, but the FHIR implementation deviates from the zib model. The zib defines these concepts as a list of official first names (as a single string) and a list of initials (as a single string), both optional. They both represent the official name(s) of a person and thus represent the same concept. In FHIR however, each first name is either a complete name or an initial, but not both. In addition, each name may be defined separately.\r\n\r\nTherefore, the zib concepts are implemented here in the following way:\r\n\r\n* Systems SHOULD use a `.given` element for each official first name that they know of (either as a full name or an initial), in order of appearance (as specified by FHIR).\r\n* Each of these elements:\r\n * SHOULD be populated with the complete name if it is known, or with the initial if no more information is available.\r\n * As noted, it SHALL be augmented with `extension:givenOrInitial`.\r\n\r\nInitials should thus not be communicated for each complete first name that is known, in contrast to what is specified by the zib. Receiving systems can recreate initials from the full names if needed.\r\n\r\nIf a system _does_ however only have a list of official first names and a separate list of official initials, without knowing the relationship between these two, only the full names SHOULD be communicated, while an additional `.name` instance MAY be used to communicate the initials. It is expected that the second instance just contains the initials and no other information from the zib. Receiving systems MAY ignore the second instance.\r\n\r\n**Note 1:** The GivenName concept should not be included here but in a separate `.name` instance where `.use` = _usual_.\r\n\r\n**Note 2**: As specified by FHIR, multiple official first names MAY be combined in a single `.given` element (separated by spaces), as long as the `.given` elements can be concatenated to form the full first name representation, and the 'extension:givenOrInitial` is used to mark the element as containing either full names or the initials. This pattern is strongly discouraged as it is hard to determine if the value pertains multiple names or a single combined name containing spaces.",
"condition" : [
"nl-core-NameInformation-01"
]
}
]
}
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.
FHIR